Swagger\Client\PinningApi
All URIs are relative to //api.estuary.tech/
Method | HTTP request | Description |
---|---|---|
pinningPinsGet | GET /pinning/pins | List all pin status objects |
pinningPinsPinidDelete | DELETE /pinning/pins/{pinid} | Delete a pinned object |
pinningPinsPinidGet | GET /pinning/pins/{pinid} | Get a pin status object |
pinningPinsPinidPost | POST /pinning/pins/{pinid} | Replace a pinned object |
pinningPinsPost | POST /pinning/pins | Add and pin object |
pinningPinsGet
\Swagger\Client\Model\TypesIpfsListPinStatusResponse pinningPinsGet()
List all pin status objects
This endpoint lists all pin status objects
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new Swagger\Client\Api\PinningApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->pinningPinsGet();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PinningApi->pinningPinsGet: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
This endpoint does not need any parameter.
Return type
\Swagger\Client\Model\TypesIpfsListPinStatusResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pinningPinsPinidDelete
pinningPinsPinidDelete($pinid)
Delete a pinned object
This endpoint deletes a pinned object.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new Swagger\Client\Api\PinningApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$pinid = "pinid_example"; // string | Pin ID
try {
$apiInstance->pinningPinsPinidDelete($pinid);
} catch (Exception $e) {
echo 'Exception when calling PinningApi->pinningPinsPinidDelete: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
Name | Type | Description | Notes |
---|---|---|---|
pinid | string | Pin ID |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pinningPinsPinidGet
\Swagger\Client\Model\TypesIpfsPinStatusResponse pinningPinsPinidGet($pinid)
Get a pin status object
This endpoint returns a pin status object.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new Swagger\Client\Api\PinningApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$pinid = "pinid_example"; // string | cid
try {
$result = $apiInstance->pinningPinsPinidGet($pinid);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PinningApi->pinningPinsPinidGet: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
Name | Type | Description | Notes |
---|---|---|---|
pinid | string | cid |
Return type
\Swagger\Client\Model\TypesIpfsPinStatusResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pinningPinsPinidPost
\Swagger\Client\Model\TypesIpfsPinStatusResponse pinningPinsPinidPost($body, $pinid)
Replace a pinned object
This endpoint replaces a pinned object.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new Swagger\Client\Api\PinningApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Swagger\Client\Model\TypesIpfsPin(); // \Swagger\Client\Model\TypesIpfsPin | New pin
$pinid = "pinid_example"; // string | Pin ID to be replaced
try {
$result = $apiInstance->pinningPinsPinidPost($body, $pinid);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PinningApi->pinningPinsPinidPost: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
Name | Type | Description | Notes |
---|---|---|---|
body | \Swagger\Client\Model\TypesIpfsPin | New pin | |
pinid | string | Pin ID to be replaced |
Return type
\Swagger\Client\Model\TypesIpfsPinStatusResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pinningPinsPost
\Swagger\Client\Model\TypesIpfsPinStatusResponse pinningPinsPost($body, $ignore_dupes, $overwrite)
Add and pin object
This endpoint adds a pin to the IPFS daemon.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new Swagger\Client\Api\PinningApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Swagger\Client\Model\TypesIpfsPin(); // \Swagger\Client\Model\TypesIpfsPin | Pin Body {cid:cid, name:name}
$ignore_dupes = "ignore_dupes_example"; // string | Ignore Dupes
$overwrite = "overwrite_example"; // string | Overwrite conflicting files in collections
try {
$result = $apiInstance->pinningPinsPost($body, $ignore_dupes, $overwrite);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PinningApi->pinningPinsPost: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
Name | Type | Description | Notes |
---|---|---|---|
body | \Swagger\Client\Model\TypesIpfsPin | Pin Body {cid:cid, name:name} | |
ignore_dupes | string | Ignore Dupes | [optional] |
overwrite | string | Overwrite conflicting files in collections | [optional] |
Return type
\Swagger\Client\Model\TypesIpfsPinStatusResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]